<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>See plot_distance_mean_by_group() — distance_by_group • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="See plot_distance_mean_by_group() — distance_by_group"><meta name="description" content="Shows distance to sites, for residents in each demographic group (vs everyone else).
plot_distance_mean_by_group() and plot_distance_by_group() are synonymous."><meta property="og:description" content="Shows distance to sites, for residents in each demographic group (vs everyone else).
plot_distance_mean_by_group() and plot_distance_by_group() are synonymous."><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>See plot_distance_mean_by_group()</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/plot_distance_mean_by_group.R" class="external-link"><code>R/plot_distance_mean_by_group.R</code></a></small>
      <div class="d-none name"><code>distance_by_group.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Shows distance to sites, for residents in each demographic group (vs everyone else).
plot_distance_mean_by_group() and plot_distance_by_group() are synonymous.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">distance_by_group</span><span class="op">(</span></span>
<span>  <span class="va">results_bybg_people</span>,</span>
<span>  demogvarname <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  demoglabel <span class="op">=</span> <span class="fu"><a href="fixcolnames.html">fixcolnames</a></span><span class="op">(</span><span class="va">demogvarname</span>, <span class="st">"r"</span>, <span class="st">"shortlabel"</span><span class="op">)</span>,</span>
<span>  returnwhat <span class="op">=</span> <span class="st">"table"</span>,</span>
<span>  graph <span class="op">=</span> <span class="cn">FALSE</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-results-bybg-people">results_bybg_people<a class="anchor" aria-label="anchor" href="#arg-results-bybg-people"></a></dt>
<dd><p>data.table from <code>doaggregate()$results_bybg_people</code></p></dd>


<dt id="arg-demogvarname">demogvarname<a class="anchor" aria-label="anchor" href="#arg-demogvarname"></a></dt>
<dd><p>vector of column names like "pctlowinc" etc.</p></dd>


<dt id="arg-demoglabel">demoglabel<a class="anchor" aria-label="anchor" href="#arg-demoglabel"></a></dt>
<dd><p>vector of labels like "Low Income Residents" etc.</p></dd>


<dt id="arg-returnwhat">returnwhat<a class="anchor" aria-label="anchor" href="#arg-returnwhat"></a></dt>
<dd><p>If returnwhat is "table", invisibly returns a
data.frame with group, ratio, avg_distance_for_group, avg_distance_for_nongroup.
If returnwhat is "plotfilename" then it returns the full path including filename of a .png in a tempdir
If returnwhat is "plot" then it returns the plot object as needed for table_xls_format() ?</p></dd>


<dt id="arg-graph">graph<a class="anchor" aria-label="anchor" href="#arg-graph"></a></dt>
<dd><p>logical optional, set to FALSE to not show the barplot and only save the file of it</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>See <code><a href="plot_distance_mean_by_group.html">plot_distance_mean_by_group()</a></code></p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>Note that the ratio shown is a ratio of distance among others to distance of a given group,
so values below 1 mean the given demographic group lives closer to facilities.
A value of 0.85 would mean the group is only 85% as far from a site as everyone else.</p>
<p>Note it is in miles assuming input was in miles, and the distance for each resident is
actually the average distance of all residents within their Census block (not block group),
and when a site is very close to the block internal point (like a centroid)
relative to the size of the block, the distance to the average resident in the block is
estimated as 90 percent of the effective radius, which is what the radius of the block
would be if it were the same area in square meters or miles but circular in shape.</p>
<p>This is the approach used in EJScreen to estimate average proximity of a block resident in
cases where the block is extremely close to the site or the site may actually be inside the block,
or exactly on top of the internal point of the block, in which case zero would not be an
appropriate estimate of the distance, hence this adjustment is made in EJAM <code><a href="getblocksnearby.html">getblocksnearby()</a></code></p>
    </div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p><code>distance_by_group()</code> <code><a href="distance_by_group_plot.html">distance_by_group_plot()</a></code></p></div>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span> <span class="va">y</span> <span class="op">&lt;-</span> <span class="fu"><a href="ejamit.html">ejamit</a></span><span class="op">(</span><span class="va">testpoints_100</span>, radius <span class="op">=</span> <span class="fl">3</span><span class="op">)</span></span>
<span> </span>
<span> <span class="co"># see barplot and table comparing groups to see which are closer to sites analyzed</span></span>
<span> <span class="fu"><a href="plot_distance_mean_by_group.html">plot_distance_mean_by_group</a></span><span class="op">(</span><span class="va">y</span><span class="op">$</span><span class="va">results_bybg_people</span><span class="op">)</span> <span class="co"># or distance_mean_by_group() synonym</span></span>
<span> </span>
<span> <span class="co"># table - proximity of sites for just one demog group vs rest of population</span></span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu">distance_by_group</span><span class="op">(</span><span class="va">y</span><span class="op">$</span><span class="va">results_bybg_people</span>,</span>
<span>   demogvarname <span class="op">=</span> <span class="st">'pctlowinc'</span><span class="op">)</span><span class="op">)</span></span>
<span>   </span>
<span> <span class="co"># plot cumulative share of group by distance vs overall population</span></span>
<span>  <span class="fu"><a href="distance_by_group_plot.html">distance_by_group_plot</a></span><span class="op">(</span><span class="va">y</span><span class="op">$</span><span class="va">results_bybg_people</span>,</span>
<span>     demogvarname <span class="op">=</span> <span class="st">'pctlowinc'</span> <span class="op">)</span></span>
<span>     </span>
<span> <span class="co"># plot cum. shares for two groups  </span></span>
<span> <span class="co"># about 14% of black and 12% of asian residents have a site within 1 mile. </span></span>
<span> <span class="co"># 29% vs 21% have a site within 1.5 miles.</span></span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/Round.html" class="external-link">round</a></span><span class="op">(</span><span class="va">xyz</span><span class="op">[</span><span class="fu"><a href="https://rdrr.io/r/base/findInterval.html" class="external-link">findInterval</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">1</span>, <span class="fl">1.5</span><span class="op">)</span>,  <span class="va">xyz</span><span class="op">$</span><span class="va">dist</span><span class="op">)</span>, <span class="op">]</span>, <span class="fl">3</span><span class="op">)</span> </span>
<span> </span>
<span> <span class="co"># plot is too busy for all groups at once so this is a way to tap through them 1 by 1</span></span>
<span> <span class="va">these</span> <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="va">names_d</span>, <span class="va">names_d_subgroups</span><span class="op">)</span></span>
<span> <span class="kw">for</span> <span class="op">(</span><span class="va">i</span> <span class="kw">in</span> <span class="fl">1</span><span class="op">:</span><span class="fu"><a href="https://rdrr.io/r/base/length.html" class="external-link">length</a></span><span class="op">(</span><span class="va">these</span><span class="op">)</span><span class="op">)</span> <span class="op">{</span></span>
<span>   <span class="fu"><a href="https://rdrr.io/r/base/readline.html" class="external-link">readline</a></span><span class="op">(</span><span class="st">"press any key to see the next plot"</span><span class="op">)</span></span>
<span>   <span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu"><a href="distance_by_group_plot.html">distance_by_group_plot</a></span><span class="op">(</span><span class="va">y</span><span class="op">$</span><span class="va">results_bybg_people</span>, demogvarname <span class="op">=</span> <span class="va">these</span><span class="op">[</span><span class="va">i</span><span class="op">]</span><span class="op">)</span> <span class="op">)</span></span>
<span> <span class="op">}</span></span>
<span> </span>
<span></span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

